diff --git a/docs/class-LINE.LINEBot.Constant.Meta.html b/docs/class-LINE.LINEBot.Constant.Meta.html index 2496ceed..c82346e3 100644 --- a/docs/class-LINE.LINEBot.Constant.Meta.html +++ b/docs/class-LINE.LINEBot.Constant.Meta.html @@ -125,7 +125,7 @@
sendNarrowcast( LINE\LINEBot\MessageBuilder $messageBuilder , LINE\LINEBot\Narrowcast\Recipient\RecipientBuilder $recipientBuilder = NULL, LINE\LINEBot\Narrowcast\DemographicFilter\DemographicFilterBuilder $demographicFilterBuilder = NULL, int|null $limit = NULL, string|null $retryKey = NULL )
+ sendNarrowcast( LINE\LINEBot\MessageBuilder $messageBuilder , LINE\LINEBot\Narrowcast\Recipient\RecipientBuilder $recipientBuilder = NULL, LINE\LINEBot\Narrowcast\DemographicFilter\DemographicFilterBuilder $demographicFilterBuilder = NULL, int|null $max = NULL, string|null $retryKey = NULL, $upToRemainingQuota = false )
getNarrowcastProgress( string $requestId )
+ getNarrowcastProgress( string $requestId )
- public
-
-
-
- createAudienceGroupForUpdatingUserIds( string $description , array $audiences = array ( ), bool $isIfaAudience = false, string|null $uploadDescription = NULL )
-
- createAudienceGroupForUploadingUserIds( string $description , array $audiences = array ( ), bool $isIfaAudience = false, string|null $uploadDescription = NULL )
+ createAudienceGroupForUploadingUserIds( string $description , array $audiences = array ( ), bool $isIfaAudience = false, string|null $uploadDescription = NULL )
createAudienceGroupForUploadingUserIdsByFile( string $description , string $filePath , bool $isIfaAudience = false, string|null $uploadDescription = NULL )
+ createAudienceGroupForUploadingUserIdsByFile( string $description , string $filePath , bool $isIfaAudience = false, string|null $uploadDescription = NULL )
- public
-
-
-
- updateAudienceGroupForUpdatingUserIds( int $audienceGroupId , array $audiences , string|null $uploadDescription = NULL )
-
- updateAudienceGroupForUploadingUserIds( int $audienceGroupId , array $audiences , string|null $uploadDescription = NULL )
+ updateAudienceGroupForUploadingUserIds( int $audienceGroupId , array $audiences , string|null $uploadDescription = NULL )
updateAudienceGroupForUploadingUserIdsByFile( int $audienceGroupId , string $filePath , string|null $uploadDescription = NULL )
+ updateAudienceGroupForUploadingUserIdsByFile( int $audienceGroupId , string $filePath , string|null $uploadDescription = NULL )
createAudienceGroupForClick( string $description , string $requestId , string|null $clickUrl = NULL )
+ createAudienceGroupForClick( string $description , string $requestId , string|null $clickUrl = NULL )
createAudienceGroupForImpression( string $description , string $requestId )
+ createAudienceGroupForImpression( string $description , string $requestId )
renameAudience( int $audienceGroupId , string $description )
+ renameAudience( int $audienceGroupId , string $description )
deleteAudience( int $audienceGroupId )
+ deleteAudience( int $audienceGroupId )
getAudience( int $audienceGroupId )
+ getAudience( int $audienceGroupId )
getAudiences( int $page , int $size = 20, string|null $description = NULL, string|null $status = NULL, bool|null $includesExternalPublicGroups = NULL, string|null $createRoute = NULL )
+ getAudiences( int $page , int $size = 20, string|null $description = NULL, string|null $status = NULL, bool|null $includesExternalPublicGroups = NULL, string|null $createRoute = NULL )
getAuthorityLevel( )
+ getAuthorityLevel( )
updateAuthorityLevel( string $authorityLevel )
+ updateAuthorityLevel( string $authorityLevel )
1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 793: 794: 795: 796: 797: 798: 799: 800: 801: 802: 803: 804: 805: 806: 807: 808: 809: 810: 811: 812: 813: 814: 815: 816: 817: 818: 819: 820: 821: 822: 823: 824: 825: 826: 827: 828: 829: 830: 831: 832: 833: 834: 835: 836: 837: 838: 839: 840: 841: 842: 843: 844: 845: 846: 847: 848: 849: 850: 851: 852: 853: 854: 855: 856: 857: 858: 859: 860: 861: 862: 863: 864: 865: 866: 867: 868: 869: 870: 871: 872: 873: 874: 875: 876: 877: 878: 879: 880: 881: 882: 883: 884: 885: 886: 887: 888: 889: 890: 891: 892: 893: 894: 895: 896: 897: 898: 899: 900: 901: 902: 903: 904: 905: 906: 907: 908: 909: 910: 911: 912: 913: 914: 915: 916: 917: 918: 919: 920: 921: 922: 923: 924: 925: 926: 927: 928: 929: 930: 931: 932: 933: 934: 935: 936: 937: 938: 939: 940: 941: 942: 943: 944: 945: 946: 947: 948: 949: 950: 951: 952: 953: 954: 955: 956: 957: 958: 959: 960: 961: 962: 963: 964: 965: 966: 967: 968: 969: 970: 971: 972: 973: 974: 975: 976: 977: 978: 979: 980: 981: 982: 983: 984: 985: 986: 987: 988: 989: 990: 991: 992: 993: 994: 995: 996: 997: 998: 999: 1000: 1001: 1002: 1003: 1004: 1005: 1006: 1007: 1008: 1009: 1010: 1011: 1012: 1013: 1014: 1015: 1016: 1017: 1018: 1019: 1020: 1021: 1022: 1023: 1024: 1025: 1026: 1027: 1028: 1029: 1030: 1031: 1032: 1033: 1034: 1035: 1036: 1037: 1038: 1039: 1040: 1041: 1042: 1043: 1044: 1045: 1046: 1047: 1048: 1049: 1050: 1051: 1052: 1053: 1054: 1055: 1056: 1057: 1058: 1059: 1060: 1061: 1062: 1063: 1064: 1065: 1066: 1067: 1068: 1069: 1070: 1071: 1072: 1073: 1074: 1075: 1076: 1077: 1078: 1079: 1080: 1081: 1082: 1083: 1084: 1085: 1086: 1087: 1088: 1089: 1090: 1091: 1092: 1093: 1094: 1095: 1096: 1097: 1098: 1099: 1100: 1101: 1102: 1103: 1104: 1105: 1106: 1107: 1108: 1109: 1110: 1111: 1112: 1113: 1114: 1115: 1116: 1117: 1118: 1119: 1120: 1121: 1122: 1123: 1124: 1125: 1126: 1127: 1128: 1129: 1130: 1131: 1132: 1133: 1134: 1135: 1136: 1137: 1138: 1139: 1140: 1141: 1142: 1143: 1144: 1145: 1146: 1147: 1148: 1149: 1150: 1151: 1152: 1153: 1154: 1155: 1156: 1157: 1158: 1159: 1160: 1161: 1162: 1163: 1164: 1165: 1166: 1167: 1168: 1169: 1170: 1171: 1172: 1173: 1174: 1175: 1176: 1177: 1178: 1179: 1180: 1181: 1182: 1183: 1184: 1185: 1186: 1187: 1188: 1189: 1190: 1191: 1192: 1193: 1194: 1195: 1196: 1197: 1198:
+ 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 793: 794: 795: 796: 797: 798: 799: 800: 801: 802: 803: 804: 805: 806: 807: 808: 809: 810: 811: 812: 813: 814: 815: 816: 817: 818: 819: 820: 821: 822: 823: 824: 825: 826: 827: 828: 829: 830: 831: 832: 833: 834: 835: 836: 837: 838: 839: 840: 841: 842: 843: 844: 845: 846: 847: 848: 849: 850: 851: 852: 853: 854: 855: 856: 857: 858: 859: 860: 861: 862: 863: 864: 865: 866: 867: 868: 869: 870: 871: 872: 873: 874: 875: 876: 877: 878: 879: 880: 881: 882: 883: 884: 885: 886: 887: 888: 889: 890: 891: 892: 893: 894: 895: 896: 897: 898: 899: 900: 901: 902: 903: 904: 905: 906: 907: 908: 909: 910: 911: 912: 913: 914: 915: 916: 917: 918: 919: 920: 921: 922: 923: 924: 925: 926: 927: 928: 929: 930: 931: 932: 933: 934: 935: 936: 937: 938: 939: 940: 941: 942: 943: 944: 945: 946: 947: 948: 949: 950: 951: 952: 953: 954: 955: 956: 957: 958: 959: 960: 961: 962: 963: 964: 965: 966: 967: 968: 969: 970: 971: 972: 973: 974: 975: 976: 977: 978: 979: 980: 981: 982: 983: 984: 985: 986: 987: 988: 989: 990: 991: 992: 993: 994: 995: 996: 997: 998: 999: 1000: 1001: 1002: 1003: 1004: 1005: 1006: 1007: 1008: 1009: 1010: 1011: 1012: 1013: 1014: 1015: 1016: 1017: 1018: 1019: 1020: 1021: 1022: 1023: 1024: 1025: 1026: 1027: 1028: 1029: 1030: 1031: 1032: 1033: 1034: 1035: 1036: 1037: 1038: 1039: 1040: 1041: 1042: 1043: 1044: 1045: 1046: 1047: 1048: 1049: 1050: 1051: 1052: 1053: 1054: 1055: 1056: 1057: 1058: 1059: 1060: 1061: 1062: 1063: 1064: 1065: 1066: 1067: 1068: 1069: 1070: 1071: 1072: 1073: 1074: 1075: 1076: 1077: 1078: 1079: 1080: 1081: 1082: 1083: 1084: 1085: 1086: 1087: 1088: 1089: 1090: 1091: 1092: 1093: 1094: 1095: 1096: 1097: 1098: 1099: 1100: 1101: 1102: 1103: 1104: 1105: 1106: 1107: 1108: 1109: 1110: 1111: 1112: 1113: 1114: 1115: 1116: 1117: 1118: 1119: 1120: 1121: 1122: 1123: 1124: 1125: 1126: 1127: 1128: 1129: 1130: 1131: 1132: 1133: 1134: 1135: 1136: 1137: 1138: 1139: 1140: 1141: 1142: 1143: 1144: 1145: 1146: 1147: 1148: 1149: 1150: 1151: 1152: 1153:
<?php
/**
@@ -931,330 +931,285 @@
MessageBuilder $messageBuilder,
RecipientBuilder $recipientBuilder = null,
DemographicFilterBuilder $demographicFilterBuilder = null,
- $limit = null,
- $retryKey = null
- ) {
- $params = [
- 'messages' => $messageBuilder->buildMessage()
- ];
- if (isset($recipientBuilder)) {
- $params['recipient'] = $recipientBuilder->build();
- }
- if (isset($demographicFilterBuilder)) {
- $params['filter'] = [
- 'demographic' => $demographicFilterBuilder->build(),
- ];
- }
- if (isset($limit)) {
- $params['limit'] = [
- 'max' => $limit
- ];
- }
- $headers = ['Content-Type: application/json; charset=utf-8'];
- if (isset($retryKey)) {
- $headers[] = HTTPHeader::LINE_RETRY_KEY . ': ' .$retryKey;
- }
- return $this->httpClient->post($this->endpointBase . '/v2/bot/message/narrowcast', $params, $headers);
- }
-
- /**
- * Get Narrowcast message sending progress.
- *
- * @param string $requestId
- * @return Response
- */
- public function getNarrowcastProgress($requestId)
- {
- $url = $this->endpointBase . '/v2/bot/message/progress/narrowcast';
- return $this->httpClient->get($url, ['requestId' => $requestId]);
- }
-
-
- /**
- * Create audience for uploading user IDs
- *
- * @deprecated 5.0.0
- * @param string $description The audience's name. Max character limit: 120
- * @param array $audiences An array of up to 10,000 user IDs or IFAs.
- * @param bool $isIfaAudience If this is false (default), recipients are specified by user IDs.
- * @param string|null $uploadDescription The description to register with the job.
- * @return Response
- */
- public function createAudienceGroupForUpdatingUserIds(
- $description,
- $audiences = [],
- $isIfaAudience = false,
- $uploadDescription = null
- ) {
- trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
- return $this->createAudienceGroupForUploadingUserIds(
- $description,
- $audiences,
- $isIfaAudience,
- $uploadDescription
- );
- }
-
- /**
- * Create audience for uploading user IDs
- *
- * @param string $description The audience's name. Max character limit: 120
- * @param array $audiences An array of up to 10,000 user IDs or IFAs.
- * @param bool $isIfaAudience If this is false (default), recipients are specified by user IDs.
- * @param string|null $uploadDescription The description to register with the job.
- * @return Response
- */
- public function createAudienceGroupForUploadingUserIds(
- $description,
- $audiences = [],
- $isIfaAudience = false,
- $uploadDescription = null
- ) {
- $params = [
- 'description' => $description,
- 'isIfaAudience' => $isIfaAudience,
- ];
- if (!empty($audiences)) {
- $params['audiences'] = $audiences;
- }
- if (isset($uploadDescription)) {
- $params['uploadDescription'] = $uploadDescription;
- }
- return $this->httpClient->post($this->endpointBase . '/v2/bot/audienceGroup/upload', $params);
- }
-
- /**
- * Create audience for uploading user IDs (by file)
- *
- * @param string $description The audience's name. Max character limit: 120
- * @param string $filePath A text file path with one user ID or IFA entered per line. Max number: 1,500,000
- * @param bool $isIfaAudience If this is false (default), recipients are specified by user IDs.
- * @param string|null $uploadDescription The description to register with the job.
- * @return Response
- */
- public function createAudienceGroupForUploadingUserIdsByFile(
- $description,
- $filePath,
- $isIfaAudience = false,
- $uploadDescription = null
- ) {
- $params = [
- 'description' => $description,
- 'isIfaAudience' => $isIfaAudience,
- 'file' => new CURLFile($filePath, 'text/plain', 'file'),
- ];
- if (isset($uploadDescription)) {
- $params['uploadDescription'] = $uploadDescription;
- }
- $url = $this->dataEndpointBase . '/v2/bot/audienceGroup/upload/byFile';
- $headers = ['Content-Type: multipart/form-data'];
- return $this->httpClient->post($url, $params, $headers);
+ $max = null,
+ $retryKey = null,
+ $upToRemainingQuota = false
+ ) {
+ $params = [
+ 'messages' => $messageBuilder->buildMessage()
+ ];
+ if (isset($recipientBuilder)) {
+ $params['recipient'] = $recipientBuilder->build();
+ }
+ if (isset($demographicFilterBuilder)) {
+ $params['filter'] = [
+ 'demographic' => $demographicFilterBuilder->build(),
+ ];
+ }
+
+ $params['limit'] = [
+ 'upToRemainingQuota' => $upToRemainingQuota,
+ ];
+ if (isset($max)) {
+ $params['limit']['max'] = $max;
+ }
+ $headers = ['Content-Type: application/json; charset=utf-8'];
+ if (isset($retryKey)) {
+ $headers[] = HTTPHeader::LINE_RETRY_KEY . ': ' .$retryKey;
+ }
+ return $this->httpClient->post($this->endpointBase . '/v2/bot/message/narrowcast', $params, $headers);
+ }
+
+ /**
+ * Get Narrowcast message sending progress.
+ *
+ * @param string $requestId
+ * @return Response
+ */
+ public function getNarrowcastProgress($requestId)
+ {
+ $url = $this->endpointBase . '/v2/bot/message/progress/narrowcast';
+ return $this->httpClient->get($url, ['requestId' => $requestId]);
+ }
+
+ /**
+ * Create audience for uploading user IDs
+ *
+ * @param string $description The audience's name. Max character limit: 120
+ * @param array $audiences An array of up to 10,000 user IDs or IFAs.
+ * @param bool $isIfaAudience If this is false (default), recipients are specified by user IDs.
+ * @param string|null $uploadDescription The description to register with the job.
+ * @return Response
+ */
+ public function createAudienceGroupForUploadingUserIds(
+ $description,
+ $audiences = [],
+ $isIfaAudience = false,
+ $uploadDescription = null
+ ) {
+ $params = [
+ 'description' => $description,
+ 'isIfaAudience' => $isIfaAudience,
+ ];
+ if (!empty($audiences)) {
+ $params['audiences'] = $audiences;
+ }
+ if (isset($uploadDescription)) {
+ $params['uploadDescription'] = $uploadDescription;
+ }
+ return $this->httpClient->post($this->endpointBase . '/v2/bot/audienceGroup/upload', $params);
+ }
+
+ /**
+ * Create audience for uploading user IDs (by file)
+ *
+ * @param string $description The audience's name. Max character limit: 120
+ * @param string $filePath A text file path with one user ID or IFA entered per line. Max number: 1,500,000
+ * @param bool $isIfaAudience If this is false (default), recipients are specified by user IDs.
+ * @param string|null $uploadDescription The description to register with the job.
+ * @return Response
+ */
+ public function createAudienceGroupForUploadingUserIdsByFile(
+ $description,
+ $filePath,
+ $isIfaAudience = false,
+ $uploadDescription = null
+ ) {
+ $params = [
+ 'description' => $description,
+ 'isIfaAudience' => $isIfaAudience,
+ 'file' => new CURLFile($filePath, 'text/plain', 'file'),
+ ];
+ if (isset($uploadDescription)) {
+ $params['uploadDescription'] = $uploadDescription;
+ }
+ $url = $this->dataEndpointBase . '/v2/bot/audienceGroup/upload/byFile';
+ $headers = ['Content-Type: multipart/form-data'];
+ return $this->httpClient->post($url, $params, $headers);
+ }
+
+ /**
+ * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs
+ *
+ * @param int $audienceGroupId The audience ID.
+ * @param array $audiences An array of up to 10,000 user IDs or IFAs.
+ * @param string|null $uploadDescription The description to register with the job.
+ * @return Response
+ */
+ public function updateAudienceGroupForUploadingUserIds(
+ $audienceGroupId,
+ $audiences,
+ $uploadDescription = null
+ ) {
+ $params = [
+ 'audienceGroupId' => $audienceGroupId,
+ 'audiences' => $audiences,
+ ];
+ if (isset($uploadDescription)) {
+ $params['uploadDescription'] = $uploadDescription;
+ }
+ return $this->httpClient->put($this->endpointBase . '/v2/bot/audienceGroup/upload', $params);
}
/**
- * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs
+ * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file)
*
- * @deprecated 5.0.0
- * @param int $audienceGroupId The audience ID.
- * @param array $audiences An array of up to 10,000 user IDs or IFAs.
- * @param string|null $uploadDescription The description to register with the job.
- * @return Response
- */
- public function updateAudienceGroupForUpdatingUserIds(
- $audienceGroupId,
- $audiences,
- $uploadDescription = null
- ) {
- trigger_error('Method ' . __METHOD__ . ' is deprecated', E_USER_DEPRECATED);
- return $this->updateAudienceGroupForUploadingUserIds(
- $audienceGroupId,
- $audiences,
- $uploadDescription
- );
- }
-
- /**
- * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs
- *
- * @param int $audienceGroupId The audience ID.
- * @param array $audiences An array of up to 10,000 user IDs or IFAs.
- * @param string|null $uploadDescription The description to register with the job.
- * @return Response
- */
- public function updateAudienceGroupForUploadingUserIds(
- $audienceGroupId,
- $audiences,
- $uploadDescription = null
- ) {
+ * @param int $audienceGroupId The audience ID.
+ * @param string $filePath A text file path with one user ID or IFA entered per line. Max number: 1,500,000
+ * @param string|null $uploadDescription The description to register with the job.
+ * @return Response
+ */
+ public function updateAudienceGroupForUploadingUserIdsByFile(
+ $audienceGroupId,
+ $filePath,
+ $uploadDescription = null
+ ) {
+ $params = [
+ 'audienceGroupId' => $audienceGroupId,
+ 'file' => new CURLFile($filePath, 'text/plain', 'file'),
+ ];
+ if (isset($uploadDescription)) {
+ $params['uploadDescription'] = $uploadDescription;
+ }
+ $url = $this->dataEndpointBase . '/v2/bot/audienceGroup/upload/byFile';
+ $headers = ['Content-Type: multipart/form-data'];
+ return $this->httpClient->put($url, $params, $headers);
+ }
+
+ /**
+ * Create audience for click-based retargeting
+ *
+ * @param string $description The audience's name. Max character limit: 120
+ * @param string $requestId The request ID of a broadcast or narrowcast message sent in the past 60 days.
+ * @param string|null $clickUrl The URL clicked by the user. Max character limit: 2,000
+ * @return Response
+ */
+ public function createAudienceGroupForClick($description, $requestId, $clickUrl = null)
+ {
$params = [
- 'audienceGroupId' => $audienceGroupId,
- 'audiences' => $audiences,
+ 'description' => $description,
+ 'requestId' => $requestId,
];
- if (isset($uploadDescription)) {
- $params['uploadDescription'] = $uploadDescription;
+ if (isset($clickUrl)) {
+ $params['clickUrl'] = $clickUrl;
}
- return $this->httpClient->put($this->endpointBase . '/v2/bot/audienceGroup/upload', $params);
+ return $this->httpClient->post($this->endpointBase . '/v2/bot/audienceGroup/click', $params);
}
/**
- * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file)
+ * Create audience for impression-based retargeting
*
- * @param int $audienceGroupId The audience ID.
- * @param string $filePath A text file path with one user ID or IFA entered per line. Max number: 1,500,000
- * @param string|null $uploadDescription The description to register with the job.
- * @return Response
- */
- public function updateAudienceGroupForUploadingUserIdsByFile(
- $audienceGroupId,
- $filePath,
- $uploadDescription = null
- ) {
- $params = [
- 'audienceGroupId' => $audienceGroupId,
- 'file' => new CURLFile($filePath, 'text/plain', 'file'),
- ];
- if (isset($uploadDescription)) {
- $params['uploadDescription'] = $uploadDescription;
- }
- $url = $this->dataEndpointBase . '/v2/bot/audienceGroup/upload/byFile';
- $headers = ['Content-Type: multipart/form-data'];
- return $this->httpClient->put($url, $params, $headers);
- }
-
- /**
- * Create audience for click-based retargeting
- *
- * @param string $description The audience's name. Max character limit: 120
- * @param string $requestId The request ID of a broadcast or narrowcast message sent in the past 60 days.
- * @param string|null $clickUrl The URL clicked by the user. Max character limit: 2,000
- * @return Response
- */
- public function createAudienceGroupForClick($description, $requestId, $clickUrl = null)
- {
- $params = [
- 'description' => $description,
- 'requestId' => $requestId,
- ];
- if (isset($clickUrl)) {
- $params['clickUrl'] = $clickUrl;
- }
- return $this->httpClient->post($this->endpointBase . '/v2/bot/audienceGroup/click', $params);
- }
-
- /**
- * Create audience for impression-based retargeting
- *
- * @param string $description The audience's name. Max character limit: 120
- * @param string $requestId The request ID of a broadcast or narrowcast message sent in the past 60 days.
- * @return Response
- */
- public function createAudienceGroupForImpression($description, $requestId)
- {
- return $this->httpClient->post($this->endpointBase . '/v2/bot/audienceGroup/imp', [
- 'description' => $description,
- 'requestId' => $requestId,
- ]);
- }
-
- /**
- * Rename an audience
- *
- * @param int $audienceGroupId The audience ID.
- * @param string $description The audience's name. Max character limit: 120
- * @return Response
- */
- public function renameAudience($audienceGroupId, $description)
- {
- $url = sprintf($this->endpointBase . '/v2/bot/audienceGroup/%s/updateDescription', urlencode($audienceGroupId));
- return $this->httpClient->put($url, ['description' => $description]);
- }
-
- /**
- * Delete audience
- *
- * @param int $audienceGroupId The audience ID.
- * @return Response
- */
- public function deleteAudience($audienceGroupId)
- {
- $url = sprintf($this->endpointBase . '/v2/bot/audienceGroup/%s', urlencode($audienceGroupId));
- return $this->httpClient->delete($url);
- }
-
- /**
- * Get audience
- *
- * @param int $audienceGroupId The audience ID.
- * @return Response
- */
- public function getAudience($audienceGroupId)
- {
- $url = sprintf($this->endpointBase . '/v2/bot/audienceGroup/%s', urlencode($audienceGroupId));
- return $this->httpClient->get($url);
- }
-
- /**
- * Get data for multiple audiences
- *
- * @param int $page The page to return when getting (paginated) results. Must be 1 or higher.
- * @param int $size The number of audiences per page. Max: 40
- * @param string|null $description You can search for partial matches.
- * @param string|null $status One of: IN_PROGRESS, READY, FAILED, EXPIRED
- * @param boolean|null $includesExternalPublicGroups
- * @param string|null $createRoute How the audience was created. One of: OA_MANAGER, MESSAGING_API
- * @return Response
- */
- public function getAudiences(
- $page,
- $size = 20,
- $description = null,
- $status = null,
- $includesExternalPublicGroups = null,
- $createRoute = null
- ) {
- $params = [
- 'page' => $page,
- 'size' => $size,
- ];
- if (isset($description)) {
- $params['description'] = $description;
- }
- if (isset($status)) {
- $params['status'] = $status;
- }
- if (isset($includesExternalPublicGroups)) {
- $params['includesExternalPublicGroups'] = $includesExternalPublicGroups;
- }
- if (isset($createRoute)) {
- $params['createRoute'] = $createRoute;
- }
- return $this->httpClient->get($this->endpointBase . '/v2/bot/audienceGroup/list', $params);
- }
-
- /**
- * Get the authority level of the audience
- *
- * @return Response
- */
- public function getAuthorityLevel()
- {
- return $this->httpClient->get($this->endpointBase . '/v2/bot/audienceGroup/authorityLevel');
- }
-
- /**
- * Change the authority level of the audience
- *
- * @param string $authorityLevel One of: PUBLIC, PRIVATE
- * @return Response
- */
- public function updateAuthorityLevel($authorityLevel)
- {
- return $this->httpClient->put($this->endpointBase . '/v2/bot/audienceGroup/authorityLevel', [
- 'authorityLevel' => $authorityLevel,
- ]);
- }
-}
-
+ * @param string $description The audience's name. Max character limit: 120
+ * @param string $requestId The request ID of a broadcast or narrowcast message sent in the past 60 days.
+ * @return Response
+ */
+ public function createAudienceGroupForImpression($description, $requestId)
+ {
+ return $this->httpClient->post($this->endpointBase . '/v2/bot/audienceGroup/imp', [
+ 'description' => $description,
+ 'requestId' => $requestId,
+ ]);
+ }
+
+ /**
+ * Rename an audience
+ *
+ * @param int $audienceGroupId The audience ID.
+ * @param string $description The audience's name. Max character limit: 120
+ * @return Response
+ */
+ public function renameAudience($audienceGroupId, $description)
+ {
+ $url = sprintf($this->endpointBase . '/v2/bot/audienceGroup/%s/updateDescription', urlencode($audienceGroupId));
+ return $this->httpClient->put($url, ['description' => $description]);
+ }
+
+ /**
+ * Delete audience
+ *
+ * @param int $audienceGroupId The audience ID.
+ * @return Response
+ */
+ public function deleteAudience($audienceGroupId)
+ {
+ $url = sprintf($this->endpointBase . '/v2/bot/audienceGroup/%s', urlencode($audienceGroupId));
+ return $this->httpClient->delete($url);
+ }
+
+ /**
+ * Get audience
+ *
+ * @param int $audienceGroupId The audience ID.
+ * @return Response
+ */
+ public function getAudience($audienceGroupId)
+ {
+ $url = sprintf($this->endpointBase . '/v2/bot/audienceGroup/%s', urlencode($audienceGroupId));
+ return $this->httpClient->get($url);
+ }
+
+ /**
+ * Get data for multiple audiences
+ *
+ * @param int $page The page to return when getting (paginated) results. Must be 1 or higher.
+ * @param int $size The number of audiences per page. Max: 40
+ * @param string|null $description You can search for partial matches.
+ * @param string|null $status One of: IN_PROGRESS, READY, FAILED, EXPIRED
+ * @param boolean|null $includesExternalPublicGroups
+ * @param string|null $createRoute How the audience was created. One of: OA_MANAGER, MESSAGING_API
+ * @return Response
+ */
+ public function getAudiences(
+ $page,
+ $size = 20,
+ $description = null,
+ $status = null,
+ $includesExternalPublicGroups = null,
+ $createRoute = null
+ ) {
+ $params = [
+ 'page' => $page,
+ 'size' => $size,
+ ];
+ if (isset($description)) {
+ $params['description'] = $description;
+ }
+ if (isset($status)) {
+ $params['status'] = $status;
+ }
+ if (isset($includesExternalPublicGroups)) {
+ $params['includesExternalPublicGroups'] = $includesExternalPublicGroups;
+ }
+ if (isset($createRoute)) {
+ $params['createRoute'] = $createRoute;
+ }
+ return $this->httpClient->get($this->endpointBase . '/v2/bot/audienceGroup/list', $params);
+ }
+
+ /**
+ * Get the authority level of the audience
+ *
+ * @return Response
+ */
+ public function getAuthorityLevel()
+ {
+ return $this->httpClient->get($this->endpointBase . '/v2/bot/audienceGroup/authorityLevel');
+ }
+
+ /**
+ * Change the authority level of the audience
+ *
+ * @param string $authorityLevel One of: PUBLIC, PRIVATE
+ * @return Response
+ */
+ public function updateAuthorityLevel($authorityLevel)
+ {
+ return $this->httpClient->put($this->endpointBase . '/v2/bot/audienceGroup/authorityLevel', [
+ 'authorityLevel' => $authorityLevel,
+ ]);
+ }
+}
+